home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / oldwish / wish.man < prev    next >
Encoding:
Text File  |  1989-01-20  |  9.6 KB  |  222 lines
  1. ' Copyright 1989 Regents of the University of California
  2. ' Permission to use, copy, modify, and distribute this
  3. ' documentation for any purpose and without fee is hereby
  4. ' granted, provided that this notice appears in all copies.
  5. ' The University of California makes no representations about
  6. ' the suitability of this material for any purpose.  It is
  7. ' provided "as is" without express or implied warranty.
  8. ' 
  9. ' $Header: /a/newcmds/wish/RCS/wish.man,v 1.2 89/01/19 16:44:25 mgbaker Exp Locker: mgbaker $ SPRITE (Berkeley)
  10. ' 
  11. .so \*(]ltmac.sprite
  12. .HS WISH cmds
  13. .BS
  14. .SH NAME
  15. wish \- Window shell and directory browser for X windows
  16. .SH SYNOPSIS
  17. .nf
  18. \fBwish\fR [\fIoptions\fR] [\fIdirectory\fR]
  19. .SH OPTIONS
  20. .IP "\fB\-nopick\fR" 14
  21. Configure \fBwish\fR so that it will not automatically pick an initial window
  22. size.  Due to X11 changes, this option is temporarily misbehaving.
  23. .IP "\fB\-resize\fR" 14
  24. Configure \fBwish\fR so that it will automatically resize a window whenever it
  25. thinks the window's contents have changed in such a way that another
  26. size would be better.  Due to X11 changes, this option is temporarily
  27. misbehaving.
  28. .IP "\fB\-empty\fR" 14
  29. Display headers for file groups that don't match any files.  The default
  30. is to display headers for file groups that contain files.
  31. .IP "\fB\-debug\fR" 14
  32. Print debug messages and do not fork into the background.  This option is
  33. primarily useful for debugging \fBwish\fR.
  34. .BE
  35. .SH DESCRIPTION
  36. .PP
  37. \fBWish\fR is a command shell and directory browser that uses the facilities
  38. of the X window system, the Sx supplementary library, and the Tcl command
  39. interpreter.  It displays a window containing a configurable list of files
  40. in the directory
  41. specified on the command line, or the directory in which it is started,
  42. if the user does not specify a command-line directory.  Because \fBwish\fR uses
  43. the Sx and Tcl facilities, its selection and other capabilities are
  44. compatible with the \fBmx\fR editor and the \fBtx\fR terminal emulator.
  45. .LP
  46. Commands are invoked through menus and key and mouse button bindings.  All
  47. three of these methods are configurable by the user, because all three of
  48. these methods actually invoke the commands through the Tcl command interpreter.
  49. .LP
  50. \fBWish\fR groups files on its display according to rules provided by the
  51. user.  These rules can include pattern-matching on the file names and various
  52. other properties, including arbitrary rules that the user can specify through
  53. Tcl procedures.  The default list of files contains all the files in the
  54. directory. (Another way of saying this is that the default matching rule
  55. is the pattern \fB*\fR.)  The user can choose attributes he wants displayed
  56. for the files, such as access times and sizes, and he can sort the files
  57. according to different attributes as well.
  58. .LP
  59. \fBWish\fR also provides user-configurable command binding that includes
  60. keyboard bindings, mouse-button bindings and also per-file-group bindings.  The
  61. latter makes it possible, for instance, to use the left mouse button to invoke
  62. a compiler by clicking on \fB*.c\fR files, but a text formatter when clicking
  63. on \fB*.tex\fR files.
  64. .LP
  65. The following sections of this manual page describe the configuration, options,
  66. and possible commands for \fBwish\fR.
  67. .LP
  68.  
  69. .SH  CONFIGURATION OPTIONS AND STARTUP COMMANDS
  70. .PP
  71. Currently most options are specified via a \fB.Xdefaults\fR file and
  72. a \fB.wish\fR file.  More command-line support will be added eventually.
  73. The following list gives the options that can be set in a
  74. user's \fB.Xdefaults\fR file, which is the general X-application startup
  75. file.  The
  76. second section describes options configurable from a wish-specific startup
  77. file, \fB.wish\fR.  \fBWish\fR will startup pleasantly even if one or both
  78. of these files are missing, but it will choose its own default configuration
  79. in this case.
  80. .SH 2 X DEFAULT OPTIONS
  81. .IP "\fBBackground\fR" 16
  82. General background color for \fBwish\fR window.
  83. .IP "\fBForeground\fR" 16
  84. General foreground color for \fBwish\fR window.
  85. .IP "\fBBorder\fR" 16
  86. Color for border of \fBwish\fR window.
  87. .IP "\fBBorderWidth\fR" 16
  88. Width of border around \fBwish\fR window.
  89. .IP "\fBSelection\fR" 16
  90. Color of selection highlighting.
  91. .IP "\fBTitleBackground\fR" 16
  92. Background color of title bar.
  93. .IP "\fBTitleForeground\fR" 16
  94. Foreground color of title bar.
  95. .IP "\fBTitleBorder\fR" 16
  96. Color of border around title bar.
  97. .IP "\fBTxBackground\fR" 16
  98. Background color of attached tx window.
  99. .IP "\fBTxForeground\fR" 16
  100. Foreground color of attached tx window.
  101. .IP "\fBTxBorder\fR" 16
  102. Border color for attached tx window.
  103. .IP "\fBMenuBackground\fR" 16
  104. Background color for menu bar.
  105. .IP "\fBMenuForeground\fR" 16
  106. Foreground color for menu bar.
  107. .IP "\fBSortBackground\fR" 16
  108. Background color for bar specifying current file-sorting method.
  109. .IP "\fBSortForeground\fR" 16
  110. Foreground color for bar specifying current file-sorting method.
  111. .IP "\fBFieldsBackground\fR" 16
  112. Background color for bar specifying displayed file attributes.
  113. .IP "\fBFieldsForeground\fR" 16
  114. Foreground color for bar specifying displayed file attributes.
  115. .IP "\fBEntryBackground\fR" 16
  116. Background color for bar allowing command entry.
  117. .IP "\fBEntryForeground\fR" 16
  118. Foreground color for bar allowing command entry.
  119. .IP "\fBScrollBackground\fR" 16
  120. Background color for scroll bar.
  121. .IP "\fBScrollForeground\fR" 16
  122. Foreground color for scroll bar.
  123. .IP "\fBScrollElevator\fR" 16
  124. Color for elevator in scroll bar.
  125. .IP "\fBGeometry\fR" 16
  126. Window geometry.
  127. .IP "\fBFont\fR" 16
  128. Font to use in \fBwish\fR window.
  129. .IP "\fBTitleFont\fR" 16
  130. Font to use in title bar.
  131. .SH 2 WISH STARTUP OPTIONS
  132. .PP
  133. The \fBwish\fR startup file, \fB.wish\fR, is used for configuring the behavior
  134. of \fBwish\fR initially, and for changing its behavior if the user changes
  135. direcotories.  Thus, each directory may have a different \fB.wish\fR file, if
  136. this is useful.
  137. .IP "\fB selection binding\fR" 20
  138. The Tcl command
  139. .br
  140. \fBvar selectionButton \fIbutton\fR
  141. .br
  142. will set \fIbutton\fR
  143. (left, right, {shift right}, etc) to be the mouse
  144. button used for selecting files and text in a \fBwish\fR window.
  145. .IP "\fBfile sorting\fR" 20
  146. The Tcl command \fBsortFiles \fImethod\fR will configure \fBwish so that
  147. inside a file group, it sorts the files by \fImethod\fR.  The default method
  148. is \fBalpha\fR for alphabetical sorting, but files may also be sorted by
  149. access times, data-modification times, size etc.  They may also be sorted
  150. in reverse order for any method.
  151. .IP "\fBdisplay fields\fR" 20
  152. The Tcl command \fBsetFields \fIfieldname\fR will add the field \fIfieldname\fR
  153. to the file attributes \fBwish\fR is currently displaying.  The default
  154. field is \fBname\fR, but other fields are \fBaccessTime\fR, \fBsize\fR, etc.
  155. \fBWish\fR will try to interpret many types of capitalizations and
  156. abbreviations for each field name.
  157. .IP "\fBdefining groups\fR" 20
  158. The Tcl command \fBdefineGroup\fR is used to define a list of files to
  159. group together on the display.  The command has two options:
  160. \fBdefineGroup comparison \fIpattern\fR create a group that chooses files
  161. using the matching rule \fIpattern\fR on file names.  For example, the command
  162. .sp
  163. \fBdefineGroup comparison B*.ms\fR
  164. .sp
  165. will create a group containing all files starting with the letter `B' and
  166. ending with the suffix `.ms'.  The other option, for arbitrary matching
  167. rules, is
  168. .br
  169. \fBdefineGroup proc \fITcl procedure\fR,
  170. .br
  171. where the given
  172. \fITcl procedure\fR must have a name, which will be the name displayed in the
  173. file group header, and parameter which takes the name of a file to test
  174. against the rule.  The rule is in the Tcl procedure body, and it must
  175. return 1 if the file matches, 0 if not, and a value less than 0 if an error
  176. occurs.  For example, the following defineGroup command will choose all
  177. files beginning with a `.', but excluding the files `.' and `..'.
  178. .sp
  179. \fBdefineGroup proc {proc DotFiles filename {
  180. .br
  181.     return [pattern {!(.) && !(..) && (.*)} $filename]
  182. .br
  183. }}\fR
  184. .sp
  185. The procedure \fBpattern\fR can be called to do arbitrary filename matching.
  186. .IP "\fBper-group command bindings\fR" 14
  187. The command \fBgroupBind \fIgroupName binding command\fR is used to bind
  188. a command, \fIcommand\fR, to a mouse binding, \fIbinding\fR,
  189. for files in a particular group, \fIgroupName\fR.  Following the usual
  190. Tcl syntax, if the command or the binding use more than one word, they
  191. must be enclosed in braces.  For instance, the following will bind the mouse
  192. button \fBshift middle\fR to execute the shell command \fBcc -g -c filename\fR,
  193. on files in the group with suffix `.c'.  The Tcl variable \fB$pointed\fR holds
  194. the name of the file pointed to with the command binding.
  195. .sp
  196. \fBgroupBind *.c {shift middle} {exec cc -g -c $pointed}\fR
  197. .sp
  198. The command \fBexec\fR is used to escape to the user's outside shell (C-shell,
  199. etc), but commands internal to \fBwish\fR can be specified directly.
  200. .IP "\fBkeyboard bindings\fR" 14
  201. Key bindings that aren't specific to particular file groups are specified
  202. with the same mechanism that \fBmx\fR and \fBtx\fR.  See their documentation
  203. for details.
  204. .IP "\fBmenu creation\fR" 14
  205. Menus are created using the same mechanism that \fBmx\fR and \fBtx\fR use.
  206. See their documentation for details.
  207.  
  208. .SH OTHER COMMANDS
  209. .PP
  210. Other commands can be found on the default set of menus.  These include
  211. commands to change directories, open new \fBwish\fR windows in other
  212. directories, etc.
  213. .LP
  214. Some commands can be invoked by using the mouse or by typing in particular
  215. places.  For instance, to change directories, the user need not use the
  216. \fBchangeDirectory\fR command from a menu or from his key bindings.  He can
  217. instead type the new directory name into the title bar that displays the
  218. current directory.  Similarly, typing in the bars that display the
  219. name of a group will change the pattern used for matching files for that group.
  220. .SH KEYWORDS
  221. command shell, X windows, directory browser
  222.